human documenation - #574
Merged
Merged
Conversation
Expanded the README to include a detailed explanation of the 'no-mistakes' tool, its advantages, and trade-offs related to AST-parsing.
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
the
documentation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 32: Update the no-mistakes description to avoid guaranteeing that
relationships are never missed: present high recall as an aspiration or advise
agents to verify important relationships, while preserving the existing warning
about potentially incorrect relationships.
- Line 31: Correct the misspelled word “understnad” to “understand” in the
README sentence describing AST parsing, leaving the rest of the text unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Updated README to improve clarity and fix typos.
This comment has been minimized.
This comment has been minimized.
Added support status for various languages and tools.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
README.md (1)
143-144: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winKeep a local link-check path for contributors.
CI still runs Lychee over
README.mdand documentation files in.github/workflows/ci.yml; removing the only README instructions leaves contributors without a documented way to reproduce that check locally. Retain a short command or link to the CI check.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 143 - 144, Restore a concise README section documenting how contributors can run the same Lychee link check locally, or link to the corresponding workflow in `.github/workflows/ci.yml`; keep the instructions aligned with the CI check covering README.md and documentation files.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 21: Update the README sentence beginning “The primary use-cases of
`no-mistakes`” to use “are” instead of “is,” preserving the rest of the wording.
- Line 33: In the README text, correct the misspelled word “determinstically” to
“deterministically” while leaving the surrounding statement unchanged.
- Around line 21-25: Add a concrete diff-input command to the README’s primary
use-cases or test-selection documentation, alongside the existing --changed-file
examples. Use the tool’s supported diff argument and show a representative diff
source so users can see how to select tests from changes.
---
Nitpick comments:
In `@README.md`:
- Around line 143-144: Restore a concise README section documenting how
contributors can run the same Lychee link check locally, or link to the
corresponding workflow in `.github/workflows/ci.yml`; keep the instructions
aligned with the CI check covering README.md and documentation files.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
This comment has been minimized.
This comment has been minimized.
jonathanong
enabled auto-merge (squash)
August 23, 2026 02:29
Keep the agent README, fix spelling, and retain current main docs such as the harness list. Co-authored-by: Cursor <cursoragent@cursor.com>
jonathanong
dismissed stale reviews from coderabbitai[bot] and coderabbitai[bot]
August 23, 2026 02:37
Addressed README merge: kept the agent Why section, fixed spelling, added --from-git-diff example, and retained main's harness ecosystem.
The human README uses both spellings, and cspell only had the singular worktree. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
difffor test selectionShepherd Journal